<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
    <title>pvscale</title>
    <link rel="stylesheet" type="text/css" href="csound.css" />
    <meta name="generator" content="DocBook XSL Stylesheets V1.78.1" />
    <link rel="home" href="index.html" title="The Canonical Csound Reference Manual" />
    <link rel="up" href="OpcodesTop.html" title="Orchestra Opcodes and Operators" />
    <link rel="prev" href="pvsbufread2.html" title="pvsbufread2" />
    <link rel="next" href="pvscent.html" title="pvscent" />
  </head>
  <body>
    <div class="navheader">
      <table width="100%" summary="Navigation header">
        <tr>
          <th colspan="3" align="center">pvscale</th>
        </tr>
        <tr>
          <td width="20%" align="left"><a accesskey="p" href="pvsbufread2.html">Prev</a> </td>
          <th width="60%" align="center">Orchestra Opcodes and Operators</th>
          <td width="20%" align="right"> <a accesskey="n" href="pvscent.html">Next</a></td>
        </tr>
      </table>
      <hr />
    </div>
    <div class="refentry">
      <a id="pvscale"></a>
      <div class="titlepage"></div>
      <a id="IndexPvscale" class="indexterm"></a>
      <div class="refnamediv">
        <h2>
          <span class="refentrytitle">pvscale</span>
        </h2>
        <p>pvscale — 
      Scale the frequency components of a pv stream.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp138118560"></a>
        <h2>Description</h2>
        <p>
      Scale the frequency components of a pv stream, resulting
      in pitch shift. Output amplitudes can be optionally modified in order
      to attempt formant preservation.
    </p>
      </div>
      <div class="refsect1">
        <a id="idp138194880"></a>
        <h2>Syntax</h2>
        <pre class="synopsis">fsig <span class="command"><strong>pvscale</strong></span> fsigin, kscal[, kkeepform, kgain, kcoefs]</pre>
      </div>
      <div class="refsect1">
        <a id="idp138197056"></a>
        <h2>Performance</h2>
        <p>
      <span class="emphasis"><em>fsig</em></span> -- output pv stream
    </p>
        <p>
      <span class="emphasis"><em>fsigin</em></span> -- input pv stream
    </p>
        <p>
      <span class="emphasis"><em>kscal</em></span> -- scaling ratio.
    </p>
        <p>
      <span class="emphasis"><em>kkeepform</em></span> -- attempt to keep input signal
      formants; 0: do not keep formants;
      1: keep formants using a liftered cepstrum method; 2: keep formants by 
      using a true envelope method
      (defaults to 0). 
    </p>
        <p>
      <span class="emphasis"><em>kgain</em></span> -- amplitude scaling (defaults to 1).
    </p>
        <p>
      <span class="emphasis"><em>kcoefs</em></span> -- number of cepstrum coefs used in formant preservation (defaults to 80).
    </p>
        <p>
      The quality of the pitch shift will be improved with the use of a
      Hanning window in the pvoc analysis. Formant preservation method 1 is less intensive than method 2, which might not be suited
      to realtime use.
    </p>
        <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
          <table border="0" summary="Warning">
            <tr>
              <td rowspan="2" align="center" valign="top" width="25">
                <img alt="[Warning]" src="images/warning.png" />
              </td>
              <th align="left">Warning</th>
            </tr>
            <tr>
              <td align="left" valign="top">
                <p>
        It is unsafe to use the same f-variable for both input and output of pvs opcodes. Using the same one might lead to undefined behavior on some opcodes. Use a different one on the left and right sides of the opcode.
      </p>
              </td>
            </tr>
          </table>
        </div>
      </div>
      <div class="refsect1">
        <a id="idp138204816"></a>
        <h2>Examples</h2>
        <p>
      </p>
        <div class="example">
          <a id="idp138205744"></a>
          <p class="title">
            <strong>Example 680. Example</strong>
          </p>
          <div class="example-contents">
            <pre class="programlisting">
asig  <span class="opc">in</span>                                 <span class="comment">; get the signal in</span>

fsig  <span class="opc">pvsanal</span>   asig, 1024, 256, 1024, 1 <span class="comment">; analyse it</span>
ftps  <span class="opc">pvscale</span>   fsig, 1.5, 1, 1          <span class="comment">; transpose it keeping formants</span>
atps  <span class="opc">pvsynth</span>   ftps                     <span class="comment">; synthesise it</span>

adp   <span class="opc">delayr</span>    0.1                      <span class="comment">; delay original signal</span>
adel  <span class="opc">deltapn</span>   1024                     <span class="comment">; by 1024 samples</span>
      <span class="opc">delayw</span>    asig
      <span class="opc">out</span>       atps <span class="op">+</span> adel              <span class="comment">; add tranposed and original</span></pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
        <p>
    The example above shows a vocal harmoniser. The delay is necessary to
    time-align the signals, as the analysis-synthesis process will imply a
    delay of 1024 samples between the analysis input and the synthesis output.
    </p>
        <p>
      Here is an example of the use of the <span class="emphasis"><em>pvscale</em></span> opcode. It uses the file <a class="ulink" href="examples/pvscale.csd" target="_top"><em class="citetitle">pvscale.csd</em></a>.
      </p>
        <div class="example">
          <a id="idp138220704"></a>
          <p class="title">
            <strong>Example 681. Example of the <span class="emphasis"><em>pvscale</em></span> opcode.</strong>
          </p>
          <div class="example-contents">
            <p>See the sections <a class="link" href="UsingRealTime.html" title="Real-Time Audio"><em class="citetitle">Real-time Audio</em></a> and <a class="link" href="CommandFlags.html" title="Csound command line"><em class="citetitle">Command Line Flags</em></a> for more information on using command line flags.</p>
            <pre class="programlisting">
<span class="csdtag">&lt;CsoundSynthesizer&gt;</span>
<span class="csdtag">&lt;CsOptions&gt;</span>
-odac
<span class="csdtag">&lt;/CsOptions&gt;</span>
<span class="csdtag">&lt;CsInstruments&gt;</span>

<span class="ohdr">sr</span> <span class="op">=</span> 44100
<span class="ohdr">ksmps</span> <span class="op">=</span> 16
<span class="ohdr">nchnls</span> <span class="op">=</span> 1
<span class="ohdr">0dbfs</span> <span class="op">=</span> 1

<span class="comment">;; example written by joachim heintz 2009</span>

<span class="oblock">instr</span> 1
ifftsize	<span class="op">=</span>		1024
ioverlap	<span class="op">=</span>		ifftsize <span class="op">/</span> 4
iwinsize	<span class="op">=</span>		ifftsize
iwinshape	<span class="op">=</span>		1<span class="comment">; von-Hann window</span>
Sfile		<span class="op">=</span>		"fox.wav"
ain		<span class="opc">soundin</span>	Sfile
fftin		<span class="opc">pvsanal</span>	ain, ifftsize, ioverlap, iwinsize, iwinshape<span class="comment">; fft-analysis of the audio-signal</span>
fftblur	<span class="opc">pvscale</span>	fftin, p4, p5, p6<span class="comment">; scale</span>
aout		<span class="opc">pvsynth</span>	fftblur<span class="comment">; resynthesis</span>
		<span class="opc">out</span>		aout
<span class="oblock">endin</span>

<span class="csdtag">&lt;/CsInstruments&gt;</span>
<span class="csdtag">&lt;CsScore&gt;</span>
<span class="stamnt">i</span> 1 0 3 1 0 1<span class="comment">; original sound</span>
<span class="stamnt">i</span> 1 3 3 1.5 0 2<span class="comment">; fifth higher without ...</span>
<span class="stamnt">i</span> 1 6 3 1.5 1 2<span class="comment">; ... and with different ...</span>
<span class="stamnt">i</span> 1 9 3 1.5 2 5<span class="comment">; ... kinds of formant preservation</span>
<span class="stamnt">e</span>
<span class="csdtag">&lt;/CsScore&gt;</span>
<span class="csdtag">&lt;/CsoundSynthesizer&gt;</span>
</pre>
          </div>
        </div>
        <p><br class="example-break" />
    </p>
      </div>
      <div class="refsect1">
        <a id="idp138225424"></a>
        <h2>See Also</h2>
        <p>
      <a class="link" href="pvsanal.html" title="pvsanal"><em class="citetitle">pvsanal</em></a>,
      <a class="link" href="pvsynth.html" title="pvsynth"><em class="citetitle">pvsynth</em></a>,
      <a class="link" href="pvsadsyn.html" title="pvsadsyn"><em class="citetitle">pvsadsyn</em></a>
    </p>
      </div>
      <div class="refsect1">
        <a id="idp138229392"></a>
        <h2>Credits</h2>
        <p>
      </p>
        <table border="0" summary="Simple list" class="simplelist">
          <tr>
            <td>Author: Victor Lazzarini</td>
          </tr>
          <tr>
            <td>November 2004 </td>
          </tr>
        </table>
        <p>
    </p>
        <p>New plugin in version 5</p>
        <p>November 2004.</p>
      </div>
    </div>
    <div class="navfooter">
      <hr />
      <table width="100%" summary="Navigation footer">
        <tr>
          <td width="40%" align="left"><a accesskey="p" href="pvsbufread2.html">Prev</a> </td>
          <td width="20%" align="center">
            <a accesskey="u" href="OpcodesTop.html">Up</a>
          </td>
          <td width="40%" align="right"> <a accesskey="n" href="pvscent.html">Next</a></td>
        </tr>
        <tr>
          <td width="40%" align="left" valign="top">pvsbufread2 </td>
          <td width="20%" align="center">
            <a accesskey="h" href="index.html">Home</a>
          </td>
          <td width="40%" align="right" valign="top"> pvscent</td>
        </tr>
      </table>
    </div>
  </body>
</html>
